<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
	<title>Cluster stats API | ElasticSearch 7.7 权威指南中文版</title>
	<meta name="keywords" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <meta name="description" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
	<link rel="stylesheet" type="text/css" href="../static/styles.css" />
	<script>
	var _link = 'cluster-stats.html';
    </script>
</head>
<body>
<div class="main-container">
    <section id="content">
        <div class="content-wrapper">
            <section id="guide" lang="zh_cn">
                <div class="container">
                    <div class="row">
                        <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                            <div style="color:gray; word-break: break-all; font-size:12px;">原英文版地址: <a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cluster-stats.html" rel="nofollow" target="_blank">https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cluster-stats.html</a>, 原文档版权归 www.elastic.co 所有<br/>本地英文版地址: <a href="../en/cluster-stats.html" rel="nofollow" target="_blank">../en/cluster-stats.html</a></div>
                        <!-- start body -->
                  <div class="page_header">
<strong>重要</strong>: 此版本不会发布额外的bug修复或文档更新。最新信息请参考 <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" rel="nofollow">当前版本文档</a>。
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="rest-apis.html">REST APIs</a></span>
»
<span class="breadcrumb-link"><a href="cluster.html">Cluster APIs</a></span>
»
<span class="breadcrumb-node">Cluster stats API</span>
</div>
<div class="navheader">
<span class="prev">
<a href="cluster-state.html">« Cluster state API</a>
</span>
<span class="next">
<a href="cluster-update-settings.html">Cluster update settings API »</a>
</span>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="cluster-stats"></a>Cluster stats API<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cluster/stats.asciidoc">edit</a>
</h2>
</div></div></div>

<p>Returns cluster statistics.</p>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cluster-stats-api-request"></a>Request<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cluster/stats.asciidoc">edit</a>
</h3>
</div></div></div>
<p><code class="literal">GET /_cluster/stats</code><br></p>
<p><code class="literal">GET /_cluster/stats/nodes/&lt;node_filter&gt;</code></p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cluster-stats-api-desc"></a>Description<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cluster/stats.asciidoc">edit</a>
</h3>
</div></div></div>
<p>The Cluster Stats API allows to retrieve statistics from a cluster wide
perspective. The API returns basic index metrics (shard numbers, store size,
memory usage) and information about the current nodes that form the cluster
(number, roles, os, jvm versions, memory usage, cpu and installed plugins).</p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cluster-stats-api-path-params"></a>Path parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cluster/stats.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;node_filter&gt;</code>
</span>
</dt>
<dd>
(Optional, string)
Comma-separated list of <a class="xref" href="cluster.html#cluster-nodes" title="Node specification">node filters</a> used to limit returned
information. Defaults to all nodes in the cluster.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cluster-stats-api-query-params"></a>Query parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cluster/stats.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">master_timeout</code>
</span>
</dt>
<dd>
(Optional, <a class="xref" href="common-options.html#time-units" title="Time units">time units</a>) Specifies the period of time to wait for
a connection to the master node. If no response is received before the timeout
expires, the request fails and returns an error. Defaults to <code class="literal">30s</code>.
</dd>
<dt>
<span class="term">
<code class="literal">timeout</code>
</span>
</dt>
<dd>
(Optional, <a class="xref" href="common-options.html#time-units" title="Time units">time units</a>) Specifies the period of time to wait for
a response. If no response is received before the timeout expires, the request
fails and returns an error. Defaults to <code class="literal">30s</code>.
</dd>
</dl>
</div>
</div>

<div class="section child_attributes">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cluster-stats-api-response-body"></a>Response body<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cluster/stats.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">_nodes</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about the number of nodes selected by the request’s
<a class="xref" href="cluster.html#cluster-nodes" title="Node specification">node filters</a>.
</p>
<details open>
<summary class="title">Properties of <code class="literal">_nodes</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">total</code>
</span>
</dt>
<dd>
(integer)
Total number of nodes selected by the request.
</dd>
<dt>
<span class="term">
<code class="literal">successful</code>
</span>
</dt>
<dd>
(integer)
Number of nodes that responded successfully to the request.
</dd>
<dt>
<span class="term">
<code class="literal">failed</code>
</span>
</dt>
<dd>
(integer)
Number of nodes that rejected the request or failed to respond. If this value
is not <code class="literal">0</code>, a reason for the rejection or failure is included in the response.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">cluster_name</code>
</span>
</dt>
<dd>
(string)
Name of the cluster, based on the <a class="xref" href="cluster.name.html" title="cluster.name"><code class="literal">cluster.name</code></a> setting.
</dd>
<dt>
<span class="term">
<code class="literal">cluster_uuid</code>
</span>
</dt>
<dd>
(string)
Unique identifier for the cluster.
</dd>
<dt>
<span class="term">
<code class="literal">timestamp</code>
</span>
</dt>
<dd>
(integer)
<a href="https://en.wikipedia.org/wiki/Unix_time" class="ulink" target="_top">Unix timestamp</a>, in milliseconds, of
the last time the cluster statistics were refreshed.
</dd>
<dt>
<span class="term">
<code class="literal">status</code>
</span>
</dt>
<dd>
<p>
(string)
Health status of the cluster, based on the state of its primary and replica
shards. Statuses are:
</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">green</code>
</span>
</dt>
<dd>
All shards are assigned.
</dd>
<dt>
<span class="term">
<code class="literal">yellow</code>
</span>
</dt>
<dd>
All primary shards are assigned, but one or more replica shards are
unassigned. If a node in the cluster fails, some
data could be unavailable until that node is repaired.
</dd>
<dt>
<span class="term">
<code class="literal">red</code>
</span>
</dt>
<dd>
One or more primary shards are unassigned, so some data is unavailable. This
can occur briefly during cluster startup as primary shards are assigned.
</dd>
</dl>
</div>
<p>See <a class="xref" href="cluster-health.html" title="Cluster health API">Cluster health</a>.</p>
</dd>
</dl>
</div>
<div class="variablelist">
<a id="cluster-stats-api-response-body-indices"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">indices</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about indices with shards assigned to selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">indices</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
(integer)
Total number of indices with shards assigned to selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">shards</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about shards assigned to selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">shards</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">total</code>
</span>
</dt>
<dd>
(integer)
Total number of shards assigned to selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">primaries</code>
</span>
</dt>
<dd>
(integer)
Number of primary shards assigned to selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">replication</code>
</span>
</dt>
<dd>
(float)
Ratio of replica shards to primary shards across all selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">index</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about shards assigned to selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">index</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">shards</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about the number of shards assigned to selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">shards</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">min</code>
</span>
</dt>
<dd>
(integer)
Minimum number of shards in an index, counting only shards assigned to
selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">max</code>
</span>
</dt>
<dd>
(integer)
Maximum number of shards in an index, counting only shards assigned to
selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">avg</code>
</span>
</dt>
<dd>
(float)
Mean number of shards in an index, counting only shards assigned to
selected nodes.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">primaries</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about the number of primary shards assigned to selected
nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">primaries</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">min</code>
</span>
</dt>
<dd>
(integer)
Minimum number of primary shards in an index, counting only shards assigned
to selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">max</code>
</span>
</dt>
<dd>
(integer)
Maximum number of primary shards in an index, counting only shards assigned
to selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">avg</code>
</span>
</dt>
<dd>
(float)
Mean number of primary shards in an index, counting only shards assigned to
selected nodes.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">replication</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about the number of replication shards assigned to selected
nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">replication</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">min</code>
</span>
</dt>
<dd>
(float)
Minimum replication factor in an index, counting only shards assigned to
selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">max</code>
</span>
</dt>
<dd>
(float)
Maximum replication factor in an index, counting only shards assigned to
selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">avg</code>
</span>
</dt>
<dd>
(float)
Mean replication factor in an index, counting only shards assigned to selected
nodes.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">docs</code>
</span>
</dt>
<dd>
<p>
(object)
Contains counts for documents in selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">docs</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
<p>
(integer)
Total number of non-deleted documents across all primary shards assigned to
selected nodes.
</p>
<p>This number is based on documents in Lucene segments and may include documents
from nested fields.</p>
</dd>
<dt>
<span class="term">
<code class="literal">deleted</code>
</span>
</dt>
<dd>
<p>
(integer)
Total number of deleted documents across all primary shards assigned to
selected nodes.
</p>
<p>This number is based on documents in Lucene segments. Elasticsearch reclaims the disk
space of deleted Lucene documents when a segment is merged.</p>
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">store</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about the size of shards assigned to selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">store</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">size</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte units</a>)
Total size of all shards assigned to selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">size_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total size, in bytes, of all shards assigned to selected nodes.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">fielddata</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about the field data cache of selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">fielddata</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">memory_size</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte units</a>)
Total amount of memory used for the field data cache across all shards
assigned to selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">memory_size_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount, in bytes, of memory used for the field data cache across all
shards assigned to selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">evictions</code>
</span>
</dt>
<dd>
(integer)
Total number of evictions from the field data cache across all shards assigned
to selected nodes.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">query_cache</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about the query cache of selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">query_cache</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">memory_size</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte units</a>)
Total amount of memory used for the query cache across all shards assigned to
selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">memory_size_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount, in bytes, of memory used for the query cache across all shards
assigned to selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">total_count</code>
</span>
</dt>
<dd>
(integer)
Total count of hits and misses in the query cache across all shards assigned to
selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">hit_count</code>
</span>
</dt>
<dd>
(integer)
Total count of query cache hits across all shards assigned to selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">miss_count</code>
</span>
</dt>
<dd>
(integer)
Total count of query cache misses across all shards assigned to selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">cache_size</code>
</span>
</dt>
<dd>
(integer)
Total number of entries currently in the query cache across all shards assigned
to selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">cache_count</code>
</span>
</dt>
<dd>
(integer)
Total number of entries added to the query cache across all shards assigned
to selected nodes. This number includes current and evicted entries.
</dd>
<dt>
<span class="term">
<code class="literal">evictions</code>
</span>
</dt>
<dd>
(integer)
Total number of query cache evictions across all shards assigned to selected
nodes.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">completion</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about memory used for completion in selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">completion</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">size</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte units</a>)
Total amount of memory used for completion across all shards assigned to
selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">size_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount, in bytes, of memory used for completion across all shards assigned
to selected nodes.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">segments</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about segments in selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">segments</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
(integer)
Total number of segments across all shards assigned to selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">memory</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte units</a>)
Total amount of memory used for segments across all shards assigned to selected
nodes.
</dd>
<dt>
<span class="term">
<code class="literal">memory_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount, in bytes, of memory used for segments across all shards assigned to
selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">terms_memory</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte units</a>)
Total amount of memory used for terms across all shards assigned to selected
nodes.
</dd>
<dt>
<span class="term">
<code class="literal">terms_memory_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount, in bytes, of memory used for terms across all shards assigned to
selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">stored_fields_memory</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte units</a>)
Total amount of memory used for stored fields across all shards assigned to
selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">stored_fields_memory_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount, in bytes, of memory used for stored fields across all shards
assigned to selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">term_vectors_memory</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte units</a>)
Total amount of memory used for term vectors across all shards assigned to
selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">term_vectors_memory_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount, in bytes, of memory used for term vectors across all shards
assigned to selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">norms_memory</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte units</a>)
Total amount of memory used for normalization factors across all shards assigned
to selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">norms_memory_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount, in bytes, of memory used for normalization factors across all
shards assigned to selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">points_memory</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte units</a>)
Total amount of memory used for points across all shards assigned to selected
nodes.
</dd>
<dt>
<span class="term">
<code class="literal">points_memory_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount, in bytes, of memory used for points across all shards assigned to
selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">doc_values_memory</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte units</a>)
Total amount of memory used for doc values across all shards assigned to
selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">doc_values_memory_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount, in bytes, of memory used for doc values across all shards assigned
to selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">index_writer_memory</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte units</a>)
Total amount of memory used by all index writers across all shards assigned to
selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">index_writer_memory_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount, in bytes, of memory used by all index writers across all shards
assigned to selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">version_map_memory</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte units</a>)
Total amount of memory used by all version maps across all shards assigned to
selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">version_map_memory_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount, in bytes, of memory used by all version maps across all shards
assigned to selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">fixed_bit_set</code>
</span>
</dt>
<dd>
<p>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte units</a>)
Total amount of memory used by fixed bit sets across all shards assigned to
selected nodes.
</p>
<p>Fixed bit sets are used for nested object field types and
type filters for <a class="xref" href="parent-join.html" title="Join datatype">join</a> fields.</p>
</dd>
<dt>
<span class="term">
<code class="literal">fixed_bit_set_memory_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount of memory, in bytes, used by fixed bit sets across all shards
assigned to selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">max_unsafe_auto_id_timestamp</code>
</span>
</dt>
<dd>
(integer)
<a href="https://en.wikipedia.org/wiki/Unix_time" class="ulink" target="_top">Unix timestamp</a>, in milliseconds, of
the most recently retried indexing request.
</dd>
<dt>
<span class="term">
<code class="literal">file_sizes</code>
</span>
</dt>
<dd>
<p>
(object)
This object is not populated by the cluster stats API.
</p>
<p>To get information on segment files, use the <a class="xref" href="cluster-nodes-stats.html" title="Nodes stats API">node stats
API</a>.</p>
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">mappings</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about <a class="xref" href="mapping.html" title="Mapping">field mappings</a> in selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">mappings</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">field_types</code>
</span>
</dt>
<dd>
<p>
(array of objects)
Contains statistics about <a class="xref" href="mapping-types.html" title="Field datatypes">field datatypes</a> used in selected
nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">field_types</code> objects</summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">name</code>
</span>
</dt>
<dd>
(string)
Field datatype used in selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
(integer)
Number of fields mapped to the field datatype in selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">index_count</code>
</span>
</dt>
<dd>
(integer)
Number of indices containing a mapping of the field datatype in selected nodes.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">analysis</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about <a class="xref" href="analyzer-anatomy.html" title="Anatomy of an analyzer">analyzers and analyzer components</a>
used in selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">analysis</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">char_filter_types</code>
</span>
</dt>
<dd>
<p>
(array of objects)
Contains statistics about <a class="xref" href="analysis-charfilters.html" title="Character filters reference">character filter</a> types used
in selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">char_filter_types</code> objects</summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">name</code>
</span>
</dt>
<dd>
(string)
Character filter type used in selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
(integer)
Number of analyzers or normalizers using the character filter type in selected
nodes.
</dd>
<dt>
<span class="term">
<code class="literal">index_count</code>
</span>
</dt>
<dd>
(integer)
Number of indices the character filter type in selected nodes.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">tokenizer_types</code>
</span>
</dt>
<dd>
<p>
(array of objects)
Contains statistics about <a class="xref" href="analysis-tokenizers.html" title="Tokenizer reference">tokenizer</a> types used in
selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">tokenizer_types</code> objects</summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">name</code>
</span>
</dt>
<dd>
(string)
Tokenizer type used in selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
(integer)
Number of analyzers or normalizers using the tokenizer type in selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">index_count</code>
</span>
</dt>
<dd>
(integer)
Number of indices using the tokenizer type in selected nodes.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">filter_types</code>
</span>
</dt>
<dd>
<p>
(array of objects)
Contains statistics about <a class="xref" href="analysis-tokenfilters.html" title="Token filter reference">token filter</a> types used in
selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">filter_types</code> objects</summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">name</code>
</span>
</dt>
<dd>
(string)
Token filter type used in selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
(integer)
Number of analyzers or normalizers using the token filter type in selected
nodes.
</dd>
<dt>
<span class="term">
<code class="literal">index_count</code>
</span>
</dt>
<dd>
(integer)
Number of indices using the token filter type in selected nodes.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">analyzer_types</code>
</span>
</dt>
<dd>
<p>
(array of objects)
Contains statistics about <a class="xref" href="analyzer-anatomy.html" title="Anatomy of an analyzer">analyzer</a> types used in selected
nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">analyzer_types</code> objects</summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">name</code>
</span>
</dt>
<dd>
(string)
Analyzer type used in selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
(integer)
Occurrences of the analyzer type in selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">index_count</code>
</span>
</dt>
<dd>
(integer)
Number of indices using the analyzer type in selected nodes.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">built_in_char_filters</code>
</span>
</dt>
<dd>
<p>
(array of objects)
Contains statistics about built-in <a class="xref" href="analysis-charfilters.html" title="Character filters reference">character filters</a>
used in selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">built_in_char_filters</code> objects</summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">name</code>
</span>
</dt>
<dd>
(string)
Built-in character filter used in selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
(integer)
Number of analyzers or normalizers using the built-in character filter in
selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">index_count</code>
</span>
</dt>
<dd>
(integer)
Number of indices using the built-in character filter in selected nodes.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">built_in_tokenizers</code>
</span>
</dt>
<dd>
<p>
(array of objects)
Contains statistics about built-in <a class="xref" href="analysis-tokenizers.html" title="Tokenizer reference">tokenizers</a> used in
selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">built_in_tokenizers</code> objects</summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">name</code>
</span>
</dt>
<dd>
(string)
Built-in tokenizer used in selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
(integer)
Number of analyzers or normalizers using the built-in tokenizer in selected
nodes.
</dd>
<dt>
<span class="term">
<code class="literal">index_count</code>
</span>
</dt>
<dd>
(integer)
Number of indices using the built-in tokenizer in selected nodes.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">built_in_filters</code>
</span>
</dt>
<dd>
<p>
(array of objects)
Contains statistics about built-in <a class="xref" href="analysis-tokenfilters.html" title="Token filter reference">token filters</a> used
in selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">built_in_filters</code> objects</summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">name</code>
</span>
</dt>
<dd>
(string)
Built-in token filter used in selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
(integer)
Number of analyzers or normalizers using the built-in token filter in selected
nodes.
</dd>
<dt>
<span class="term">
<code class="literal">index_count</code>
</span>
</dt>
<dd>
(integer)
Number of indices using the built-in token filter in selected nodes.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">built_in_analyzers</code>
</span>
</dt>
<dd>
<p>
(array of objects)
Contains statistics about built-in <a class="xref" href="analysis-analyzers.html" title="Built-in analyzer reference">analyzers</a> used in
selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">built_in_analyzers</code> objects</summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">name</code>
</span>
</dt>
<dd>
(string)
Built-in analyzer used in selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
(integer)
Occurrences of the built-in analyzer in selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">index_count</code>
</span>
</dt>
<dd>
(integer)
Number of indices using the built-in analyzer in selected nodes.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
<div class="variablelist">
<a id="cluster-stats-api-response-body-nodes"></a>
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">nodes</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about nodes selected by the request’s <a class="xref" href="cluster.html#cluster-nodes" title="Node specification">node
filters</a>.
</p>
<details open>
<summary class="title">Properties of <code class="literal">nodes</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
<p>
(object)
Contains counts for nodes selected by the request’s <a class="xref" href="cluster.html#cluster-nodes" title="Node specification">node
filters</a>.
</p>
<details open>
<summary class="title">Properties of <code class="literal">count</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">total</code>
</span>
</dt>
<dd>
(integer)
Total number of selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">coordinating_only</code>
</span>
</dt>
<dd>
(integer)
Number of selected nodes without a <a class="xref" href="modules-node.html" title="Node">role</a>. These nodes are
considered <a class="xref" href="modules-node.html#coordinating-only-node" title="Coordinating only node">coordinating only</a> nodes.
</dd>
<dt>
<span class="term">
<code class="literal">&lt;role&gt;</code>
</span>
</dt>
<dd>
(integer)
Number of selected nodes with the role. For a list of roles, see
<a class="xref" href="modules-node.html" title="Node">Node</a>.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">versions</code>
</span>
</dt>
<dd>
(array of strings)
Array of Elasticsearch versions used on selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">os</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about the operating systems used by selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">os</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">available_processors</code>
</span>
</dt>
<dd>
(integer)
Number of processors available to JVM across all selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">allocated_processors</code>
</span>
</dt>
<dd>
<p>
(integer)
Number of processors used to calculate thread pool size across all selected
nodes.
</p>
<p>This number can be set with the <code class="literal">processors</code> setting of a node and defaults to
the number of processors reported by the OS. In both cases, this number will
never be larger than <code class="literal">32</code>.</p>
</dd>
<dt>
<span class="term">
<code class="literal">names</code>
</span>
</dt>
<dd>
<p>
(array of objects)
Contains statistics about operating systems used by selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">names</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">name</code>
</span>
</dt>
<dd>
(string)
Name of an operating system used by one or more selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
(string)
Number of selected nodes using the operating system.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">pretty_names</code>
</span>
</dt>
<dd>
<p>
(array of objects)
Contains statistics about operating systems used by selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">pretty_names</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">pretty_name</code>
</span>
</dt>
<dd>
(string)
Human-readable name of an operating system used by one or more selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
(string)
Number of selected nodes using the operating system.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">mem</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about memory used by selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">mem</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">total</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte units</a>)
Total amount of physical memory across all selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">total_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total amount, in bytes, of physical memory across all selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">free</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte units</a>)
Amount of free physical memory across all selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">free_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Amount, in bytes, of free physical memory across all selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">used</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte units</a>)
Amount of physical memory in use across all selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">used_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Amount, in bytes, of physical memory in use across all selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">free_percent</code>
</span>
</dt>
<dd>
(integer)
Percentage of free physical memory across all selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">used_percent</code>
</span>
</dt>
<dd>
(integer)
Percentage of physical memory in use across all selected nodes.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">process</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about processes used by selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">process</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">cpu</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about CPU used by selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">cpu</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">percent</code>
</span>
</dt>
<dd>
(integer)
Percentage of CPU used across all selected nodes. Returns <code class="literal">-1</code> if
not supported.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">open_file_descriptors</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about open file descriptors in selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">open_file_descriptors</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">min</code>
</span>
</dt>
<dd>
(integer)
Minimum number of concurrently open file descriptors across all selected nodes.
Returns <code class="literal">-1</code> if not supported.
</dd>
<dt>
<span class="term">
<code class="literal">max</code>
</span>
</dt>
<dd>
(integer)
Maximum number of concurrently open file descriptors allowed across all selected
nodes. Returns <code class="literal">-1</code> if not supported.
</dd>
<dt>
<span class="term">
<code class="literal">avg</code>
</span>
</dt>
<dd>
(integer)
Average number of concurrently open file descriptors. Returns <code class="literal">-1</code> if not
supported.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">jvm</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about the Java Virtual Machines (JVMs) used by selected
nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">jvm</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">max_uptime</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#time-units" title="Time units">time unit</a>)
Uptime duration since JVM last started.
</dd>
<dt>
<span class="term">
<code class="literal">max_uptime_in_millis</code>
</span>
</dt>
<dd>
(integer)
Uptime duration, in milliseconds, since JVM last started.
</dd>
<dt>
<span class="term">
<code class="literal">versions</code>
</span>
</dt>
<dd>
<p>
(array of objects)
Contains statistics about the JVM versions used by selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">versions</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">version</code>
</span>
</dt>
<dd>
(string)
Version of JVM used by one or more selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">vm_name</code>
</span>
</dt>
<dd>
(string)
Name of the JVM.
</dd>
<dt>
<span class="term">
<code class="literal">vm_version</code>
</span>
</dt>
<dd>
<p>
(string)
Full version number of JVM.
</p>
<p>The full version number includes a plus sign (<code class="literal">+</code>) followed by the build number.</p>
</dd>
<dt>
<span class="term">
<code class="literal">vm_vendor</code>
</span>
</dt>
<dd>
(string)
Vendor of the JVM.
</dd>
<dt>
<span class="term">
<code class="literal">bundled_jdk</code>
</span>
</dt>
<dd>
(boolean)
If <code class="literal">true</code>, the JVM includes a bundled Java Development Kit (JDK).
</dd>
<dt>
<span class="term">
<code class="literal">using_bundled_jdk</code>
</span>
</dt>
<dd>
(boolean)
If <code class="literal">true</code>, a bundled JDK is in use by JVM.
</dd>
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
(integer)
Total number of selected nodes using JVM.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">mem</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about memory used by selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">mem</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">heap_used</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte units</a>)
Memory currently in use by the heap across all selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">heap_used_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Memory, in bytes, currently in use by the heap across all selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">heap_max</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte units</a>)
Maximum amount of memory, in bytes, available for use by the heap across all
selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">heap_max_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Maximum amount of memory, in bytes, available for use by the heap across all
selected nodes.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">threads</code>
</span>
</dt>
<dd>
(integer)
Number of active threads in use by JVM across all selected nodes.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">fs</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about file stores by selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">fs</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">total</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte units</a>)
Total size of all file stores across all selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">total_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total size, in bytes, of all file stores across all seleced nodes.
</dd>
<dt>
<span class="term">
<code class="literal">free</code>
</span>
</dt>
<dd>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte units</a>)
Amount of unallocated disk space in file stores across all selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">free_in_bytes</code>
</span>
</dt>
<dd>
(integer)
Total number of unallocated bytes in file stores across all selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">available</code>
</span>
</dt>
<dd>
<p>
(<a class="xref" href="common-options.html#byte-units" title="Byte size units">byte units</a>)
Total amount of disk space available to JVM in file
stores across all selected nodes.
</p>
<p>Depending on OS or process-level restrictions, this amount may be less than
<code class="literal">nodes.fs.free</code>. This is the actual amount of free disk space the selected Elasticsearch
nodes can use.</p>
</dd>
<dt>
<span class="term">
<code class="literal">available_in_bytes</code>
</span>
</dt>
<dd>
<p>
(integer)
Total number of bytes available to JVM in file stores
across all selected nodes.
</p>
<p>Depending on OS or process-level restrictions, this number may be less than
<code class="literal">nodes.fs.free_in_byes</code>. This is the actual amount of free disk space the
selected Elasticsearch nodes can use.</p>
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">plugins</code>
</span>
</dt>
<dd>
<p>
(array of objects)
Contains statistics about installed plugins and modules by selected nodes.
</p>
<p>If no plugins or modules are installed, this array is empty.</p>
<details open>
<summary class="title">Properties of <code class="literal">plugins</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;plugin&gt;</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about an installed plugin or module.
</p>
<details open>
<summary class="title">Properties of <code class="literal">&lt;plugin&gt;</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">name</code>
</span>
</dt>
<dd>
(string)
Name of the Elasticsearch plugin.
</dd>
<dt>
<span class="term">
<code class="literal">version</code>
</span>
</dt>
<dd>
(string)
Elasticsearch version for which the plugin was built.
</dd>
<dt>
<span class="term">
<code class="literal">elasticsearch_version</code>
</span>
</dt>
<dd>
(string)
Elasticsearch version for which the plugin was built.
</dd>
<dt>
<span class="term">
<code class="literal">java_version</code>
</span>
</dt>
<dd>
(string)
Java version for which the plugin was built.
</dd>
<dt>
<span class="term">
<code class="literal">description</code>
</span>
</dt>
<dd>
(string)
Short description of the plugin.
</dd>
<dt>
<span class="term">
<code class="literal">classname</code>
</span>
</dt>
<dd>
(string)
Class name used as the plugin’s entry point.
</dd>
<dt>
<span class="term">
<code class="literal">extended_plugins</code>
</span>
</dt>
<dd>
<p>
(array of strings)
An array of other plugins extended by this plugin through the Java Service
Provider Interface (SPI).
</p>
<p>If this plugin extends no other plugins, this array is empty.</p>
</dd>
<dt>
<span class="term">
<code class="literal">has_native_controller</code>
</span>
</dt>
<dd>
(boolean)
If <code class="literal">true</code>, the plugin has a native controller process.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">network_types</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about the transport and HTTP networks used by selected
nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">network_types</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">transport_types</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about the transport network types used by selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">transport_types</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;transport_type&gt;</code>
</span>
</dt>
<dd>
(integer)
Number of selected nodes using the transport type.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">http_types</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about the HTTP network types used by selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">http_types</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;http_type&gt;</code>
</span>
</dt>
<dd>
(integer)
Number of selected nodes using the HTTP type.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">discovery_types</code>
</span>
</dt>
<dd>
<p>
(object)
Contains statistics about the <a class="xref" href="modules-discovery-hosts-providers.html" title="Discovery">discovery
types</a> used by selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">discovery_types</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;discovery_type&gt;</code>
</span>
</dt>
<dd>
(integer)
Number of selected nodes using the <a class="xref" href="modules-discovery-hosts-providers.html" title="Discovery">discovery
type</a> to find other nodes.
</dd>
</dl>
</div>
</div>
</details>
</dd>
<dt>
<span class="term">
<code class="literal">packaging_types</code>
</span>
</dt>
<dd>
<p>
(array of objects)
Contains statistics about Elasticsearch distributions installed on selected nodes.
</p>
<details open>
<summary class="title">Properties of <code class="literal">packaging_types</code></summary>
<div class="content">
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">flavor</code>
</span>
</dt>
<dd>
(string)
Type of Elasticsearch distribution, such as <code class="literal">default</code> or <code class="literal">OSS</code>, used by one or more
selected nodes.
</dd>
<dt>
<span class="term">
<code class="literal">type</code>
</span>
</dt>
<dd>
(string)
File type, such as <code class="literal">tar</code> or <code class="literal">zip</code>, used for the distribution package.
</dd>
<dt>
<span class="term">
<code class="literal">count</code>
</span>
</dt>
<dd>
(integer)
Number of selected nodes using the distribution flavor and file type.
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>
</details>
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="cluster-stats-api-example"></a>Examples<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/cluster/stats.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET /_cluster/stats?human&amp;pretty</pre>
</div>
<div class="console_widget" data-snippet="snippets/1396.console"></div>
<p>The API returns the following response:</p>
<div class="pre_wrapper lang-js">
<pre class="programlisting prettyprint lang-js">{
   "_nodes" : {
      "total" : 1,
      "successful" : 1,
      "failed" : 0
   },
   "cluster_uuid": "YjAvIhsCQ9CbjWZb2qJw3Q",
   "cluster_name": "elasticsearch",
   "timestamp": 1459427693515,
   "status": "green",
   "indices": {
      "count": 1,
      "shards": {
         "total": 5,
         "primaries": 5,
         "replication": 0,
         "index": {
            "shards": {
               "min": 5,
               "max": 5,
               "avg": 5
            },
            "primaries": {
               "min": 5,
               "max": 5,
               "avg": 5
            },
            "replication": {
               "min": 0,
               "max": 0,
               "avg": 0
            }
         }
      },
      "docs": {
         "count": 10,
         "deleted": 0
      },
      "store": {
         "size": "16.2kb",
         "size_in_bytes": 16684
      },
      "fielddata": {
         "memory_size": "0b",
         "memory_size_in_bytes": 0,
         "evictions": 0
      },
      "query_cache": {
         "memory_size": "0b",
         "memory_size_in_bytes": 0,
         "total_count": 0,
         "hit_count": 0,
         "miss_count": 0,
         "cache_size": 0,
         "cache_count": 0,
         "evictions": 0
      },
      "completion": {
         "size": "0b",
         "size_in_bytes": 0
      },
      "segments": {
         "count": 4,
         "memory": "8.6kb",
         "memory_in_bytes": 8898,
         "terms_memory": "6.3kb",
         "terms_memory_in_bytes": 6522,
         "stored_fields_memory": "1.2kb",
         "stored_fields_memory_in_bytes": 1248,
         "term_vectors_memory": "0b",
         "term_vectors_memory_in_bytes": 0,
         "norms_memory": "384b",
         "norms_memory_in_bytes": 384,
         "points_memory" : "0b",
         "points_memory_in_bytes" : 0,
         "doc_values_memory": "744b",
         "doc_values_memory_in_bytes": 744,
         "index_writer_memory": "0b",
         "index_writer_memory_in_bytes": 0,
         "version_map_memory": "0b",
         "version_map_memory_in_bytes": 0,
         "fixed_bit_set": "0b",
         "fixed_bit_set_memory_in_bytes": 0,
         "max_unsafe_auto_id_timestamp" : -9223372036854775808,
         "file_sizes": {}
      },
      "mappings": {
        "field_types": []
      },
      "analysis": {
        "char_filter_types": [],
        "tokenizer_types": [],
        "filter_types": [],
        "analyzer_types": [],
        "built_in_char_filters": [],
        "built_in_tokenizers": [],
        "built_in_filters": [],
        "built_in_analyzers": []
      }
   },
   "nodes": {
      "count": {
         "total": 1,
         "data": 1,
         "coordinating_only": 0,
         "master": 1,
         "ingest": 1,
         "voting_only": 0
      },
      "versions": [
         "7.7.1"
      ],
      "os": {
         "available_processors": 8,
         "allocated_processors": 8,
         "names": [
            {
               "name": "Mac OS X",
               "count": 1
            }
         ],
         "pretty_names": [
            {
               "pretty_name": "Mac OS X",
               "count": 1
            }
         ],
         "mem" : {
            "total" : "16gb",
            "total_in_bytes" : 17179869184,
            "free" : "78.1mb",
            "free_in_bytes" : 81960960,
            "used" : "15.9gb",
            "used_in_bytes" : 17097908224,
            "free_percent" : 0,
            "used_percent" : 100
         }
      },
      "process": {
         "cpu": {
            "percent": 9
         },
         "open_file_descriptors": {
            "min": 268,
            "max": 268,
            "avg": 268
         }
      },
      "jvm": {
         "max_uptime": "13.7s",
         "max_uptime_in_millis": 13737,
         "versions": [
            {
               "version": "12",
               "vm_name": "OpenJDK 64-Bit Server VM",
               "vm_version": "12+33",
               "vm_vendor": "Oracle Corporation",
               "bundled_jdk": true,
               "using_bundled_jdk": true,
               "count": 1
            }
         ],
         "mem": {
            "heap_used": "57.5mb",
            "heap_used_in_bytes": 60312664,
            "heap_max": "989.8mb",
            "heap_max_in_bytes": 1037959168
         },
         "threads": 90
      },
      "fs": {
         "total": "200.6gb",
         "total_in_bytes": 215429193728,
         "free": "32.6gb",
         "free_in_bytes": 35064553472,
         "available": "32.4gb",
         "available_in_bytes": 34802409472
      },
      "plugins": [
        {
          "name": "analysis-icu",
          "version": "7.7.1",
          "description": "The ICU Analysis plugin integrates Lucene ICU module into elasticsearch, adding ICU relates analysis components.",
          "classname": "org.elasticsearch.plugin.analysis.icu.AnalysisICUPlugin",
          "has_native_controller": false
        },
        ...
      ],
      "ingest": {
        "number_of_pipelines" : 1,
        "processor_stats": {
          ...
        }
      },
      "network_types": {
        ...
      },
      "discovery_types": {
        ...
      },
      "packaging_types": [
        {
          ...
        }
      ]
   }
}</pre>
</div>
<p>This API can be restricted to a subset of the nodes using <a class="xref" href="cluster.html#cluster-nodes" title="Node specification">node
filters</a>:</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET /_cluster/stats/nodes/node1,node*,master:false</pre>
</div>
<div class="console_widget" data-snippet="snippets/1397.console"></div>
</div>

</div>
<div class="navfooter">
<span class="prev">
<a href="cluster-state.html">« Cluster state API</a>
</span>
<span class="next">
<a href="cluster-update-settings.html">Cluster update settings API »</a>
</span>
</div>
</div>

                  <!-- end body -->
                        </div>
                        <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                        
                        </div>
                    </div>
                </div>
            </section>
        </div>
    </section>
</div>
<script src="../static/cn.js"></script>
</body>
</html>